home *** CD-ROM | disk | FTP | other *** search
/ CD Exchange / CD Exchange - Volume 1.iso / graphics / utils / hamlabplus_demo / documentation / cmd-ref.doc next >
Text File  |  1992-08-09  |  40KB  |  1,527 lines
  1. HAMLAB PLUS 2.0.8
  2. AREXX / CONFIG FILE COMMAND REFERENCE
  3.  
  4. (c) Copyright 1992 J. E. Hanway.  All rights reserved.
  5.  
  6. IN THIS DOCUMENT:
  7.  
  8. BACKGROUND
  9.  
  10. AREXX SYNTAX
  11.  
  12. CONFIG FILE SYNTAX
  13.  
  14. COMMAND LIST
  15.  
  16. COMMAND DESCRIPTIONS
  17.  
  18. HAMLAB PLUS ATTRIBUTES
  19.  
  20. BACKGROUND
  21.  
  22. HAMLAB PLUS uses the standard AmigaDOS command syntax for both AREXX
  23. commands and config file commands.
  24.  
  25. A good description of AmigaDOS command conventions can be found in
  26. Chapter 8 of "Using the System Software," the AmigaOS Release 2 User's
  27. manual.
  28.  
  29. All commands are valid in AREXX programs.  A subset are also valid in
  30. config files.  Those are noted by one or more of the following special
  31. symbols after the command name:
  32.  
  33.   * means that the command is valid in a config file
  34.   S means the command will be included in a file generated by the
  35.     "Save Config" operation
  36.   A means the command will be included in a file generated by the
  37.     "Save All" operation
  38.  
  39. All commands and keywords are insensitive to upper/lower case.
  40.  
  41. String arguments should be enclosed in double quotes and may include
  42. spaces and the following escape sequences:
  43.  
  44.         \n      new line
  45.         \r      carriage return
  46.         \t      horizontal tab
  47.         \a      bell
  48.         \\      backslash
  49.         \nnn    nnn is three octal digits representing the character
  50.                 code
  51.  
  52.  
  53. AREXX SYNTAX
  54.  
  55. In order to pass a command to HAMLAB PLUS from an AREXX program, it
  56. must be distinguished from a built-in AREXX command, usually by
  57. enclosing it in single quotes to make it a string.  For example, to
  58. display the message "Hello, world!" in an AREXX program, the actual
  59. line in the program could look like:
  60.  
  61. 'MESSAGE "Hello, world!"'
  62.  
  63. The external single quotes are interpreted by AREXX, and the internal
  64. double quotes are processed by HAMLAB PLUS.  Of course, it is probably
  65. more typical to build complex commands using AREXX's string operators.
  66. For example:
  67.  
  68. 'MESSAGE' '"Current value of foo,bar is' foo||','||bar '"'
  69.  
  70. CONFIG FILE SYNTAX
  71.  
  72. Although config files share some of the same commands as AREXX
  73. programs, they are NOT AREXX programs.  Although this means that you
  74. can't use AREXX program statements and variables in your config files,
  75. it does mean that config files will work on all systems, whether AREXX
  76. is present or not.
  77.  
  78. Commands in config files should not be enclosed in extra quotes like
  79. AREXX programs.
  80.  
  81. Comment lines may be included in config files by starting the line
  82. with a '#' character.
  83.  
  84. Note that HamLab 1.x config files cannot be used by HAMLAB PLUS.
  85.  
  86. COMMAND LIST
  87.  
  88. ASKFIRST        *A
  89. BEEP            *A
  90. BITPLANES       *SA
  91. CACHE12BIT      *A
  92. CACHE24BIT      *A
  93. CLEAR
  94. CLEARCONFIG     *A
  95. CLOSE
  96. COMPATIBILITY   *A
  97. CURVE           *
  98. CURVEPOINT      *
  99. DISPLAY
  100. DITHER          *SA
  101. DITHER2         *SA
  102. EXPORT
  103. FILTERPATH      *A
  104. FIXHAM          *A
  105. GAMMA           *SA
  106. GETATTR
  107. INPUTCROP       *S
  108. LOADCONFIG      *
  109. LOADCURVES      *A
  110. LOADPALETTE     *A
  111. LOCKBACKGROUND  *SA
  112. LOCKGUI
  113. MESSAGE         *
  114. MODULE          *A
  115. NOP             *
  116. ONESTEP         *SA
  117. OPEN
  118. OUTPUTCROP      *S
  119. PALETTEMODE     *SA
  120. PAN
  121. PIPEDEV         *A
  122. QUIT
  123. REQUESTFILE
  124. REQUESTNOTIFY
  125. REQUESTNUMBER
  126. REQUESTRESPONSE
  127. REQUESTSTRING
  128. RESOLUTION      *SA
  129. REVERT
  130. REXXCONSOLE     *A
  131. SAVE
  132. SAVEAS
  133. SAVECONFIG
  134. SAVECURVES
  135. SAVEMODE        *SA
  136. SAVEPALETTE
  137. SCALE           *SA
  138. SETCURVE        *SA
  139. SETREQ          *A
  140. TEMPPATH        *A
  141. UNLOCKGUI
  142. WINDOW          *A
  143.  
  144. ASKFIRST        *A
  145.  
  146. Format:   ASKFIRST [ON=TRUE=YES | OFF=FALSE=NO]
  147.  
  148. Template: ON=TRUE=YES/S,OFF=FALSE=NO/S
  149.  
  150. Purpose:  Turns "are you sure" requesters on or off.
  151.  
  152. Description:
  153.  
  154. This command controls whether requesters are displayed whenever an
  155. open or clear operation will cause unsaved work to be lost.
  156.  
  157. Example:
  158.         ASKFIRST NO
  159.  
  160.  
  161. BEEP            *A
  162.  
  163. Format:   BEEP [ON=TRUE=YES | OFF=FALSE=NO]
  164.  
  165. Template: ON=TRUE=YES/S,OFF=FALSE=NO/S
  166.  
  167. Purpose:  Turns beeping on or off.
  168.  
  169. Description:
  170.  
  171. This command controls the "Beep after long functions" setting, which
  172. causes a beep and screen flash after any display, save, or export
  173. function.
  174.  
  175. Example:
  176.         BEEP YES
  177.  
  178.  
  179. BITPLANES       *SA
  180.  
  181. Format:   BITPLANES [1 | 2 | 3 | 4 | 5 | HALFBRITE | HAM]
  182.  
  183. Template: 1/S,2/S,3/S,4/S,5/S,HALFBRITE/S,HAM/S
  184.  
  185. Purpose:  Sets the number and type of bitplanes for the output.
  186.  
  187. Description:
  188.  
  189. This command sets the number of bitplanes to display and save.  Normal
  190. modes allow 1-5 bit planes (1-4 in hires).  In addition, the special
  191. HAM and HALFBRITE keywords (available only in lores) select those
  192. special 6 bit plane modes.
  193.  
  194. Examples:
  195.         BITPLANES 4             [4 bit planes]
  196.         BITPLANES HAM           [HAM mode (implies 6 bit planes)]
  197.  
  198.  
  199. CACHE12BIT      *A
  200.  
  201. Format:   CACHE12BIT [MEM <memsize>] [DISK <disksize>]
  202.  
  203. Template: MEM/N/K,DISK/N/K
  204.  
  205. Purpose:  Sets the size(s) of the 12 bit caches.
  206.  
  207. Description:
  208.  
  209. This command sets the maximum memory and/or disk size of the 12-bit
  210. cache.  The sizes are specified in bytes.  You may use "-1" to
  211. indicate a very large cache.  (This is quite useful for a RAM cache
  212. since it tells HAMLAB PLUS to use as much RAM as necessary.  If that
  213. much RAM is not available, HL+ will automatically switch to a disk
  214. cache, if enabled.)  Specifying a zero will disable either a ram or
  215. disk cache.
  216.  
  217. For the 12-bit cache, 2 bytes are required for each pixel.
  218.  
  219. If the cache is already in use, the new settings will not take effect
  220. until other changes require the cache to be discarded.
  221.  
  222. Example:
  223.         CACHE12BIT MEM -1 DISK 0        [max memory cache, no disk]
  224.  
  225.  
  226. CACHE24BIT      *A
  227.  
  228. Format:   CACHE24BIT [MEM <memsize>] [DISK <disksize>]
  229.  
  230. Template: MEM/N/K,DISK/N/K
  231.  
  232. Purpose:  Sets the size(s) of the 24 bit caches.
  233.  
  234. Description:
  235.  
  236. This command sets the maximum memory and/or disk size of the 24-bit
  237. cache.  The sizes are specified in bytes.  You may use "-1" to
  238. indicate a very large cache.  (This is quite useful for a RAM cache
  239. since it tells HAMLAB PLUS to use as much RAM as necessary.  If that
  240. much RAM is not available, HL+ will automatically switch to a disk
  241. cache, if enabled.)  Specifying a zero will disable either a ram or
  242. disk cache.
  243.  
  244. For the 24-bit cache, 3 bytes are required for each pixel.
  245.  
  246. If the cache is already in use, the new settings will not take effect
  247. until other changes require the cache to be discarded.
  248.  
  249. Example:
  250.         CACHE24BIT MEM -1 DISK 10000000    [max mem cache, 10 megs disk]
  251.  
  252.  
  253. CLEAR
  254.  
  255. Format:   CLEAR [FORCE]
  256.  
  257. Template: FORCE/S
  258.  
  259. Purpose:  Clears the current image and all related memory and disk
  260. caches.
  261.  
  262. Description:
  263.  
  264. Unloads the current image from memory, and frees any temporary memory
  265. or disk space used by the image.
  266.  
  267. The FORCE keyword suppresses the confirmation requester.
  268.  
  269. Examples:
  270.         CLEAR                           [displays requester]
  271.         CLEAR FORCE                     [no requester]
  272.  
  273.  
  274. CLEARCONFIG     *A
  275.  
  276. Format:   CLEARCONFIG
  277.  
  278. Template: ,
  279.  
  280. Purpose:  Clears the lists of known input filter and exporter modules.
  281.  
  282. Description:
  283.  
  284. This command is used to clear out the list of know input filter and
  285. exporter modules so that a new set can be loaded.  The "Save All"
  286. command saves a CLEARCONFIG command at the beginning of a config file.
  287.  
  288. Example:
  289.         CLEARCONFIG
  290.  
  291.  
  292. CLOSE
  293.  
  294. Format:   CLOSE [FORCE]
  295.  
  296. Template: ,
  297.  
  298. Purpose:  Clears the current image and all related memory and disk
  299. caches.
  300.  
  301. Description:
  302.  
  303. CLOSE and CLEAR perform exactly the same function.
  304.  
  305. Examples:
  306.         CLOSE                           [displays requester]
  307.         CLOSE FORCE                     [no requester]
  308.  
  309.  
  310. COMPATIBILITY   *A
  311.  
  312. Format:   COMPATIBILITY [<mask>]
  313.  
  314. Template: /N/K
  315.  
  316. Purpose:  Sets internal compatibility switches.
  317.  
  318. This command allows certain internal settings of HAMLAB PLUS to be
  319. changed.  It takes a single argument, which is a 32-bit mask (32
  320. separate binary flags.)  The following bits are defined:
  321.  
  322.   Bit  Value  Meaning
  323.  
  324.    0      1   Write IFF palettes with RGB values like 00, 10, 20, ...
  325.               instead of 00, 11, 22, ... ff.  The latter method is
  326.               correct, but some programs, especially older ones, may
  327.               not handle those color values correctly.
  328.  
  329.    1      2   Use Release 2 functions to set pixels in the display
  330.               rather than writing to the display directly.
  331.  
  332.    2-31       Reserved for future use.  (Do